Fix #31: Complete HTML report configuration section #37
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add missing breaking change rule properties to PrepareConfigData method: * treat_added_type_as_breaking * treat_added_member_as_breaking * treat_added_interface_as_breaking * treat_removed_interface_as_breaking * treat_parameter_name_change_as_breaking * treat_added_optional_parameter_as_breaking - Add missing fail_on_breaking_changes property to configuration data - Update configuration.scriban template to display all breaking change rules - Organize breaking change rules into logical sections (Removal, Addition, Modification, Interface) - Add missing exclusion properties (exclude_compiler_generated, exclude_obsolete) to template - Add CSS styles for h4 headings in configuration sections - Improve readability and organization of configuration display All acceptance criteria from Issue #31 are now met: ✅ HTML report displays complete filter configuration ✅ HTML report displays complete mapping configuration ✅ HTML report displays complete exclusion configuration ✅ HTML report displays complete breaking change rules ✅ Configuration values are clearly labeled and formatted ✅ Empty/default values are handled appropriately
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes Issue #31 by completing the HTML report's configuration section to display all configuration values used during API comparison, improving transparency and reproducibility of results.
- Added missing breaking change rule properties and
fail_on_breaking_changesto the configuration data - Enhanced the HTML template with missing exclusion properties and reorganized breaking change rules into logical groupings
- Added CSS styles for better visual organization of configuration sections
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/DotNetApiDiff/Reporting/HtmlFormatterScriban.cs |
Added missing breaking change rule properties and fail_on_breaking_changes to PrepareConfigData method |
src/DotNetApiDiff/Reporting/HtmlTemplates/configuration.scriban |
Added missing exclusion properties and reorganized breaking change rules with h4 headings for better structure |
src/DotNetApiDiff/Reporting/HtmlTemplates/styles.css |
Added CSS styles for h4 headings in configuration sections |
src/DotNetApiDiff/Reporting/HtmlTemplates/configuration.scriban
Outdated
Show resolved
Hide resolved
- Fixed Scriban template parameter indexing (/bin/zsh is template name, use / for data) - Added Dictionary to object array conversion for template compatibility - Updated all configuration template includes to use correct parameter positions - Enhanced configuration data preparation with proper object structure conversion - Added ComparisonConfiguration to ComparisonResult for template access - Removed debug code and cleaned up for production readiness Fixes #31: Configuration sections now display properly with correct labels and data
- Created config-boolean-item.scriban template to eliminate HTML duplication - Replaced 17 repetitive boolean config item blocks with template includes - Improved maintainability by centralizing boolean item HTML structure - Enhanced template readability and consistency across all config sections - Follows established parameter pattern ( for label, for boolean value)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes Issue #31 by completing the HTML report's configuration section to display all configuration values that are used during the comparison.
Problem
The HTML report's configuration section was incomplete and didn't display many of the configuration values that affect the comparison results, making it difficult for users to verify what configuration was used or reproduce results.
Solution
🔧 Code Changes
Enhanced
HtmlFormatterScriban.cs:PrepareConfigDatamethod:treat_added_type_as_breakingtreat_added_member_as_breakingtreat_added_interface_as_breakingtreat_removed_interface_as_breakingtreat_parameter_name_change_as_breakingtreat_added_optional_parameter_as_breakingfail_on_breaking_changespropertyUpdated
configuration.scribantemplate:exclude_compiler_generated,exclude_obsolete)Enhanced
styles.css:✅ All Acceptance Criteria Met
🧪 Testing
📸 Screenshots
The HTML report now displays a comprehensive configuration section with:
🔗 Related
Closes #31
Review Notes
The changes are backward compatible and only enhance the HTML report output. No breaking changes to existing functionality.
The configuration display is now complete and provides full transparency into all settings that affect the comparison process, improving auditability and reproducibility of results.